SixBit API Schema
OrderType Complex Type
SixBit API Schema : OrderType Complex Type
Description
The information about an order.
Namespace (none)
Diagram
Shipments Element Any Sequence CustomFields Element ReferenceID Element eBayAddressID Element Phone Element Country Element PostalCode Element State Element City Element AddressLine3 Element AddressLine2 Element AddressLine1 Element Company Element LastName Element Initial Element FirstName Element Name Element All BillingAddress Element Any Sequence CustomFields Element ReferenceID Element eBayAddressID Element Phone Element Country Element PostalCode Element State Element City Element AddressLine3 Element AddressLine2 Element AddressLine1 Element Company Element LastName Element Initial Element FirstName Element Name Element All ShippingAddress Element ReferenceID Element eBayAddressID Element Phone Element Country Element PostalCode Element State Element City Element AddressLine3 Element AddressLine2 Element AddressLine1 Element Company Element LastName Element Initial Element FirstName Element Name Element All BillingAddress Element Suffix Element Prefix Element WebAddress Element Title Element DateLastModified Element SalesTaxID Element Notes Element Fax Element Phone Element Company Element LastName Element Initial Element FirstName Element eBayUserid Element Email Element BuyerID Element All Buyer Element AdFee Element SiteOrderID Element GiftWrapPrice Element GiftMessage Element NeedsGiftWrap Element IsGift Element EarliestDeliveryDate Element EarliestShipDate Element LatestDeliveryDate Element LatestShipDate Element PayPalTransactionID Element ExternalTransactionID Element RemainingDueAmount Element PaymentProcessingFee Element FeedbackReminderSentDate Element PaymentAckSentDate Element IsFeedbackReminderSent Element IsPaymentAckSent Element Notes Element SalesTax Element FulfilledDate Element CreatedDate Element Site Element BusinessProfileName Element BusinessProfileID Element CheckoutCompleted Element PaymentClearedDate Element PaymentReceivedDate Element PaymentType Element AdjustmentCostReason Element AdjustmentCost Element AdjustmentFeeReason Element AdjustmentFee Element TotalDueAmount Element TotalPaidAmount Element InvoicedDate Element IsInvoiced Element SubStatusName Element SubStatusID Element Status Element ExternalOrderID Element OrderID Element All OrderType Complex Type
Overview
OrderType
The information about an order.
All
OrderID optional OrderIDType Simple Type
ExternalOrderID optional ExternalOrderIDType Simple Type
Status optional OrderStatusType Simple Type
SubStatusID optional SubStatusIDType Simple Type
SubStatusName optional SubStatusNameType Simple Type
IsInvoiced optional IsInvoicedType Simple Type
InvoicedDate optional InvoicedDateType Simple Type
TotalPaidAmount optional TotalPaidAmountType Simple Type
TotalDueAmount optional TotalDueAmountType Simple Type
AdjustmentFee optional AdjustmentFeeType Simple Type
AdjustmentFeeReason optional AdjustmentFeeReasonType Simple Type
AdjustmentCost optional AdjustmentCostType Simple Type
AdjustmentCostReason optional AdjustmentCostReasonType Simple Type
PaymentType optional PaymentTypeType Simple Type
PaymentReceivedDate optional PaymentReceivedDateType Simple Type
PaymentClearedDate optional PaymentClearedDateType Simple Type
CheckoutCompleted optional CheckoutCompletedType Simple Type
BusinessProfileID optional BusinessProfileIDType Simple Type
BusinessProfileName optional BusinessProfileNameType Simple Type
Site optional SiteType Simple Type
CreatedDate optional CreatedDateType Simple Type
FulfilledDate optional FulfilledDateType Simple Type
SalesTax optional SalesTaxType Simple Type
Notes optional NotesType Simple Type
IsPaymentAckSent optional IsPaymentAckSentType Simple Type
IsFeedbackReminderSent optional IsFeedbackReminderSentType Simple Type
PaymentAckSentDate optional PaymentAckSentDateType Simple Type
FeedbackReminderSentDate optional FeedbackReminderSentDateType Simple Type
PaymentProcessingFee optional PaymentProcessingFeeType Simple Type
RemainingDueAmount optional RemainingDueAmountType Simple Type
ExternalTransactionID optional ExternalTransactionIDType Simple Type
PayPalTransactionID optional PayPalTransactionIDType Simple Type
LatestShipDate optional LatestShipDateType Simple Type
LatestDeliveryDate optional LatestDeliveryDateType Simple Type
EarliestShipDate optional EarliestShipDateType Simple Type
EarliestDeliveryDate optional EarliestDeliveryDateType Simple Type
IsGift optional IsGiftType Simple Type
NeedsGiftWrap optional NeedsGiftWrapType Simple Type
GiftMessage optional GiftMessageType Simple Type
GiftWrapPrice optional GiftWrapPriceType Simple Type
SiteOrderID optional SiteOrderIDType Simple Type
AdFee optional AdFeeType Simple Type
Buyer optional BuyerType Complex Type
All
BuyerID optional BuyerIDType Simple Type
Email optional EmailType Simple Type
eBayUserid optional eBayUseridType Simple Type
FirstName optional FirstNameType Simple Type
Initial optional InitialType Simple Type
LastName optional LastNameType Simple Type
Company optional CompanyType Simple Type
Phone optional PhoneType Simple Type
Fax optional FaxType Simple Type
Notes optional NotesType Simple Type
SalesTaxID optional SalesTaxIDType Simple Type
DateLastModified optional DateLastModifiedType Simple Type
Title optional NameTitleType Simple Type
WebAddress optional WebAddressType Simple Type
Prefix optional PrefixType Simple Type
Suffix optional SuffixType Simple Type
BillingAddress optional AddressType Complex Type
ShippingAddress optional AddressType Complex Type
CustomFields optional CustomFieldsType Complex Type
Sequence
Any 0..∞
BillingAddress optional AddressType Complex Type
CustomFields optional CustomFieldsType Complex Type
Sequence
Any 0..∞
Shipments optional
Sequence
Shipment 1..∞ ShipmentType Complex Type
All
ShipmentID optional ShipmentIDType Simple Type
ExternalShipmentID optional ExternalShipmentIDType Simple Type
OrderID optional OrderIDType Simple Type
ExternalOrderID optional ExternalOrderIDType Simple Type
ShippingServiceID optional ShippingServiceIDType Simple Type
ShippedDate optional ShippedDateType Simple Type
HandlingFee optional HandlingFeeType Simple Type
ChargedShippingCost optional ChargedShippingCostType Simple Type
ActualShippingCost optional ActualShippingCostType Simple Type
ActualInsuranceCost optional ActualInsuranceCostType Simple Type
TrackingNumber optional TrackingNumberType Simple Type
WeightMajor optional WeightMajorType Simple Type
WeightMinor optional WeightMinorType Simple Type
DimensionLength optional DimensionLengthType Simple Type
DimensionWidth optional DimensionWidthType Simple Type
DimensionDepth optional DimensionDepthType Simple Type
InsuranceType optional InsuranceTypeType Simple Type
InsuredValue optional InsuredValueType Simple Type
IsPackingListPrinted optional IsPackingListPrintedType Simple Type
IsPostagePrinted optional IsPostagePrintedType Simple Type
InsuredDate optional InsuredDateType Simple Type
InsuranceID optional InsuranceIDType Simple Type
Notes optional NotesType Simple Type
IsMissing optional IsMissingType Simple Type
IsShipped optional IsShippedType Simple Type
IsShippedNotificationSent optional IsShippedNotificationSentType Simple Type
ShippedNotificationSentDate optional ShippedNotificationSentDateType Simple Type
FulfillmentSource optional FulfillmentSourceType Simple Type
IsDropShipperNotified optional IsDropShipperNotifiedType Simple Type
DropShipperNotifiedDate optional DropShipperNotifiedDateType Simple Type
OriginTemplateID optional OriginTemplateIDType Simple Type
OriginTemplateName optional OriginTemplateNameType Simple Type
IsScanFormPrinted optional IsScanFormPrintedType Simple Type
IsUSPSPickupRequested optional IsUSPSPickupRequestedType Simple Type
IntegratedCarrierID optional IntegratedCarrierIDType Simple Type
ScanFormManifestID optional ScanFormManifestIDType Simple Type
USPSPickupManifestID optional USPSPickupManifestIDType Simple Type
SiteOrderID optional SiteOrderIDType Simple Type
ShippingAddress optional AddressType Complex Type
CustomFields optional CustomFieldsType Complex Type
Sequence
Any 0..∞
Sales optional
Sequence
Sale 1..∞ SaleType Complex Type
The information about a sale.
All
SaleID optional SaleIDType Simple Type
ItemID optional ItemIDType Simple Type
ExternalItemID optional ExternalItemIDType Simple Type
SKU optional SKUType Simple Type
ProductID optional ProductIDType Simple Type
ShipmentID optional ShipmentIDType Simple Type
ExternalShipmentID optional ExternalShipmentIDType Simple Type
OrderID optional OrderIDType Simple Type
ExternalOrderID optional ExternalOrderIDType Simple Type
eCommerceID optional eCommerceIDType Simple Type
TransactionID optional TransactionIDType Simple Type
Title optional TitleType Simple Type
ListingType optional ListingTypeType Simple Type
SalePrice optional SalePriceType Simple Type
QtySold optional QtySoldType Simple Type
SalesTax optional SalesTaxType Simple Type
FVF optional FVFType Simple Type
SaleDate optional SaleDateType Simple Type
InDispute optional InDisputeType Simple Type
DisputeID optional DisputeIDType Simple Type
FVFRefundRequestedDate optional FVFRefundRequestedDateType Simple Type
WeightMajor optional WeightMajorType Simple Type
WeightMinor optional WeightMinorType Simple Type
FeedbackReceived optional FeedbackReceivedType Simple Type
FeedbackLeft optional FeedbackLeftType Simple Type
Notes optional NotesType Simple Type
ExtendedPrice optional ExtendedPriceType Simple Type
FeedbackMessageReceived optional FeedbackMessageReceivedType Simple Type
FeedbackResponseSent optional FeedbackResponseSentType Simple Type
FeedbackMessageSent optional FeedbackMessageSentType Simple Type
FeedbackTypeReceived optional FeedbackTypeReceivedType Simple Type
FeedbackTypeSent optional FeedbackTypeSentType Simple Type
ConsignmentPlanID optional ConsignmentPlanIDType Simple Type
ConsignmentPlanName optional ConsignmentPlanNameType Simple Type
IsConsigned optional IsConsignedType Simple Type
IsConsignorPaid optional IsConsignorPaidType Simple Type
ConsignorPaidDate optional ConsignorPaidDateType Simple Type
ConsignorNotifiedDate optional ConsignorNotifiedDateType Simple Type
IsConsignorNotificationSent optional IsConsignorNotificationSentType Simple Type
CommissionIn optional CommissionInType Simple Type
TotalConsignorCharges optional TotalConsignorChargesType Simple Type
ConsignorListingFee optional ConsignorListingFeeType Simple Type
PaymentProcessingFee optional PaymentProcessingFeeType Simple Type
ConversionRate optional ConversionRateType Simple Type
CurrencyCode optional CurrencyCodeType Simple Type
RawSalePrice optional RawSalePriceType Simple Type
SiteSalesTaxCollectedAmount optional SiteSalesTaxCollectedAmountType Simple Type
AdFee optional AdFeeType Simple Type
CustomFields optional CustomFieldsType Complex Type
Sequence
Any 0..∞
Used By
Order Element
Source
<xs:complexType name="OrderType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>The information about an order.</xs:documentation>
  </xs:annotation>
  <xs:all>
    <xs:element name="OrderID" type="OrderIDType" maxOccurs="1" minOccurs="0" />
    <xs:element name="ExternalOrderID" type="ExternalOrderIDType" maxOccurs="1" minOccurs="0" />
    <xs:element name="Status" type="OrderStatusType" maxOccurs="1" minOccurs="0" />
    <xs:element name="SubStatusID" type="SubStatusIDType" maxOccurs="1" minOccurs="0" />
    <xs:element name="SubStatusName" type="SubStatusNameType" maxOccurs="1" minOccurs="0" />
    <xs:element name="IsInvoiced" type="IsInvoicedType" maxOccurs="1" minOccurs="0" />
    <xs:element name="InvoicedDate" type="InvoicedDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="TotalPaidAmount" type="TotalPaidAmountType" maxOccurs="1" minOccurs="0" />
    <xs:element name="TotalDueAmount" type="TotalDueAmountType" maxOccurs="1" minOccurs="0" />
    <xs:element name="AdjustmentFee" type="AdjustmentFeeType" maxOccurs="1" minOccurs="0" />
    <xs:element name="AdjustmentFeeReason" type="AdjustmentFeeReasonType" maxOccurs="1" minOccurs="0" />
    <xs:element name="AdjustmentCost" type="AdjustmentCostType" maxOccurs="1" minOccurs="0" />
    <xs:element name="AdjustmentCostReason" type="AdjustmentCostReasonType" maxOccurs="1" minOccurs="0" />
    <xs:element name="PaymentType" type="PaymentTypeType" maxOccurs="1" minOccurs="0" />
    <xs:element name="PaymentReceivedDate" type="PaymentReceivedDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="PaymentClearedDate" type="PaymentClearedDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="CheckoutCompleted" type="CheckoutCompletedType" maxOccurs="1" minOccurs="0" />
    <xs:element name="BusinessProfileID" type="BusinessProfileIDType" maxOccurs="1" minOccurs="0" />
    <xs:element name="BusinessProfileName" type="BusinessProfileNameType" maxOccurs="1" minOccurs="0" />
    <xs:element name="Site" type="SiteType" maxOccurs="1" minOccurs="0" default="None" />
    <xs:element name="CreatedDate" type="CreatedDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="FulfilledDate" type="FulfilledDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="SalesTax" type="SalesTaxType" maxOccurs="1" minOccurs="0" />
    <xs:element name="Notes" type="NotesType" maxOccurs="1" minOccurs="0" />
    <xs:element name="IsPaymentAckSent" type="IsPaymentAckSentType" maxOccurs="1" minOccurs="0" />
    <xs:element name="IsFeedbackReminderSent" type="IsFeedbackReminderSentType" maxOccurs="1" minOccurs="0" />
    <xs:element name="PaymentAckSentDate" type="PaymentAckSentDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="FeedbackReminderSentDate" type="FeedbackReminderSentDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="PaymentProcessingFee" type="PaymentProcessingFeeType" maxOccurs="1" minOccurs="0" />
    <xs:element name="RemainingDueAmount" type="RemainingDueAmountType" maxOccurs="1" minOccurs="0" />
    <xs:element name="ExternalTransactionID" type="ExternalTransactionIDType" maxOccurs="1" minOccurs="0" />
    <xs:element name="PayPalTransactionID" type="PayPalTransactionIDType" maxOccurs="1" minOccurs="0" />
    <xs:element name="LatestShipDate" type="LatestShipDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="LatestDeliveryDate" type="LatestDeliveryDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="EarliestShipDate" type="EarliestShipDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="EarliestDeliveryDate" type="EarliestDeliveryDateType" maxOccurs="1" minOccurs="0" />
    <xs:element name="IsGift" type="IsGiftType" maxOccurs="1" minOccurs="0" />
    <xs:element name="NeedsGiftWrap" type="NeedsGiftWrapType" maxOccurs="1" minOccurs="0" />
    <xs:element name="GiftMessage" type="GiftMessageType" maxOccurs="1" minOccurs="0" />
    <xs:element name="GiftWrapPrice" type="GiftWrapPriceType" maxOccurs="1" minOccurs="0" />
    <xs:element name="SiteOrderID" maxOccurs="1" minOccurs="0" type="SiteOrderIDType" />
    <xs:element name="AdFee" maxOccurs="1" minOccurs="0" type="AdFeeType" />
    <xs:element name="Buyer" type="BuyerType" maxOccurs="1" minOccurs="0" />
    <xs:element name="BillingAddress" type="AddressType" maxOccurs="1" minOccurs="0" />
    <xs:element name="CustomFields" maxOccurs="1" minOccurs="0" type="CustomFieldsType" />
    <xs:element name="Shipments" minOccurs="0" maxOccurs="1">
      <xs:complexType>
        <xs:sequence>
          <xs:element name="Shipment" type="ShipmentType" maxOccurs="unbounded" minOccurs="1" />
        </xs:sequence>
      </xs:complexType>
    </xs:element>
  </xs:all>
</xs:complexType>
See Also
SixBit API Schema

 

 

© 2022 All Rights Reserved.

Send comments on this topic.